Repository navigation
[docs] Simplify and update tutorials - #1690
Merged
Merged
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified for the tutorial updates.
No open issues 🎉
What changed in this PR
Simplifies the rclnodejs tutorials for #1689, building on the existing first-nodes guide with shorter, practical examples and clearer API guidance.
Changes:
- Reorganizes the tutorial index and replaces repetitive examples with ES modules and ROS 2 CLI walkthroughs.
- Updates guidance on parameter validation, lifecycle cleanup, action cancellation, and observable subscription ownership.
- Clarifies middleware filtering, service-event delivery, and type discovery, and refreshes ROS 2 Lyrical links.
| File | Description |
|---|---|
| tutorials/type-description-service.md | Adds a focused endpoint-discovery and type-query walkthrough. |
| tutorials/service-introspection.md | Simplifies event monitoring and explains delivery and correlation limits. |
| tutorials/README.md | Groups tutorials by configuration, communication, and inspection. |
| tutorials/parameter-service.md | Updates validation, startup overrides, and callback guidance. |
| tutorials/observable-subscriptions.md | Demonstrates stream processing and distinguishes cleanup responsibilities. |
| tutorials/lifecycle-nodes.md | Shows reusable lifecycle resources, cleanup, and CLI transitions. |
| tutorials/content-filtering-subscription.md | Clarifies middleware support, filter updates, and traffic limitations. |
| tutorials/actionlib.md | Provides server/client examples with feedback and cooperative cancellation. |
Review effort: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix: #1689